First things first, you'll need to provide a copy of a clean, headered1 Super Mario World ROM (USA version) renamed to clean.smc
and placed in the "resources" folder so it can be found by the build tool. Take care to ensure the file extension* is .smc
and not .sfc
.
It is important to do this step otherwise you can't get started.
*this may require you to turn on extensions in Windows' File Explorer.1If your rom does not have a header–which you will notice because tools will be unable to work with it–open it in Lunar Magic and you will be prompted to add a header. Hit "OK" after being prompted but DO NOT SAVE the rom.
To start using the baserom you will first have to initialize the project as it comes without any of the tools bundled. You can do this by running the provided script: !initialize_baserom.bat
. In Windows, this can be done by double clicking on it in File Explorer, or executing it from a Terminal or the Command Line.
The script will launch a new command line window where you will see the following menu.
----------------------------------- RHR Baserom v5 - Initialization ----------------------------------- Welcome! To get started with the baserom, run both of the following steps: 1. Download and set up all baserom tools 2. Run first build of the Baserom 0. Exit Enter the number of your choice
Both step 1 and 2 are required to make sure things are all good to go.
"1. Download and setup all baserom tools"
This step will check if the tools required by the baserom are setup, and if not it will download them.
"2. Run first build of the Baserom"
This step will build the baserom from scratch using Callisto so you can get right to hacking on your project.
If the first build fails, run Callisto manually from the buildtool folder so you can see what went wrong.
To learn the details of the initialization process is you can read the Baserom Initialization documentation.
If everything has been set-up correctly, with all tools set-up and the first build was successfull, the baserom is ready for use!
You can jump right into working on your project by running "callisto.exe" from the buildtool folder and select "Edit" to launch Lunar Magic. From Lunar Magic you can access much of your project with the custom User Toolbar.
Important: don't run the baserom's tool's individually. Use Callisto to make all changes your project.
If you have further questions you can read the FAQ or Basics pages or visit the #baserom-support
in the Romhack Races Discord server.